home *** CD-ROM | disk | FTP | other *** search
/ Cobra Utilities for Doom & Doom II / Cobra Utilities For Doom & Doom II - Disc 1.iso / files / level / lmpvol1 / alfred.txt next >
Encoding:
Text File  |  1994-03-23  |  15.4 KB  |  351 lines
  1.      A L F R E D -  THE AUTOMATIC LMP FILE RECORDER AND DEVELOPER v1.2
  2.  
  3.                              INSTRUCTION MANUAL
  4.                                   03/12/94
  5.  
  6. ================
  7. [1] INTRODUCTION
  8. ================
  9.  
  10. The Automatic Lmp File REcorder and Developer (ALFRED) is a very handy
  11. utility to simplfy the recording, viewing and storing of the many .LMPs one
  12. may collect over time. It automatically looks for the chosen .LMP file in the
  13. seven .LMP directories, and will act accordingly for .LMPs that were made with
  14. RANDOOM .W or PWAD .wad files.
  15.  
  16. The program was simple enough to be written in the DOS batch language, which
  17. has one major advantage- practically ANYONE can change the way it works to
  18. suit whatever needs they want. If you don't like the way it works, FIX IT
  19. YOURSELF! 
  20.  
  21. Please read ALL of this document, since some things mentioned early in this
  22. document may only be explained in later sections (RanDOOM & PWAD .LMPs).
  23.  
  24.  
  25. ============
  26. [2] FEATURES
  27. ============
  28.  
  29. ALFRED has been designed to record and play many different types of .LMPs
  30. quickly and efficiently. ALFRED can currently do the following:
  31.  
  32.   -     Record regular .LMPs from any episode, map, and skill through 
  33.         user-friendly prompts.
  34.  
  35.   -     Play .LMPs from other directories, which avoids cluttering up your
  36.         DOOM directory with .LMPs.
  37.  
  38.   -     Display introductory text files before the .LMP is played. Very 
  39.         handy for remembering what each .LMP is about.
  40.  
  41.   -     Play and record .LMPs made with a RanDOOM configuration. All you need
  42.         to provide is the weight file and the character seed, and ALFRED
  43.         will take care of the rest.
  44.  
  45.   -     Creates (from a Blank template) or edits introductory text files and
  46.         RanDOOM weight files using the MS-DOS editor.
  47.  
  48.   -     Play and record .LMPs made with different PWAD files. 
  49.         
  50. As with most programmers, however, I have the nasty habit of always 
  51. adding "just one more" feature. There's always room for improvment, and in 
  52. the future I plan to add the following:
  53.  
  54.   -   Recording Multiplayer .LMPs (if possible).
  55.   -   Automatic compression and uncompression of .LMPs using .zip files.
  56.   -   Slideshow feature. 
  57.   -   Full screen, frame-by-frame .LMP editor, allowing you to pause,
  58.       rewind and fast-forward an .LMP -- NOT! (Still, I wonder if that could
  59.       be done in a batch file? Hmmm...)
  60.  
  61. Programming Gurus please note: ALFRED was originally just a 5 line batch file 
  62. designed just to play an .LMP, but as you can see things sorta got out of 
  63. hand. Since the program is a batch file, you've been given the chance to see 
  64. how much my code looks like pasta. Please, no comments. I already know you 
  65. can do better. I am in no way a professional programmer, and if I was, I'd 
  66. be working for ID software. 
  67.  
  68.  
  69. ==============================
  70. [3] ALFRED'S FILE ORGANIZATION
  71. ==============================
  72.  
  73. Because of the large amount of .LMP files one can collect over time, ALFRED 
  74. has been designed to group them into seven separate directories (in the LMP 
  75. directory), named as follows:
  76.  
  77.    HALL         :   Hall of Fame .LMPs
  78.    LEVELS       :   .LMPs of every level
  79.    MISC         :   Strange and/or weird miscellaneous .LMPs
  80.    MULTIPLR     :   Multiplayer .LMPs (none found yet - sorry!)
  81.    NITEMARE     :   NIGHTMARE! .LMPs
  82.    PWAD         :   PWAD .LMPs and their respective .wad pwad files.
  83.    RANDOOM      :   RanDOOM .LMPs with their respective .W weight files.
  84.  
  85. (NOTE: whenever I mention 'the seven directories' later on in the document, 
  86.  I am referring to those above)
  87.  
  88. ALFRED will ONLY look for .LMPs in these seven directories. If you want 
  89. ALFRED to play your old .LMPs you will either have to copy them into any of
  90. these directories, or modify the LMP.BAT to make ALFRED look elsewhere. When 
  91. recording an .LMP with ALFRED, you will be asked what directory you wish the 
  92. .LMP to be stored in. Once the .LMP is recorded, it will be moved to the 
  93. chosen directory. NOTE: RanDOOM and PWAD .LMPs will automatically be stored 
  94. in their respective directories. 
  95.  
  96. Right now ALFRED, called LMP.BAT ('ALFRED' is too long to type, ok?), is 
  97. configured to run in your DOOM directory, and assumes to have the LMP 
  98. directory (and its seven subdirectories) in the DOOM directory as well. Once 
  99. again, being a batch file, ALFRED can be edited and changed to look elsewhere. 
  100.  
  101.  
  102. ==========================
  103. [4] PARAMETER DESCRIPTIONS
  104. ==========================
  105.  
  106. ALFRED has several parameters, some of which must be executed in order. 
  107. The general usage is as follows:
  108.  
  109.               LMP [r|w|t|p] lmpfile [pwadfile|seed]
  110.  
  111. Please note:
  112.                 - No extensions (.lmp, .w, .txt, .wad) are necessary.
  113.                 - typing LMP LIST will get a directory of all the .LMP files
  114.                   in the seven directories.
  115.  
  116. Descriptions:
  117.  
  118. lmpfile :  Could be either lmpfile.lmp, lmpfile.w or lmpfile.txt 
  119.  
  120.   r     :  Record an .LMP. If a 3rd parameter is given, it is assumed to be
  121.            a pwad file. If the pwad file is not in the WADS directory, 
  122.            ALFRED will ask if the 3rd parameter was intended to be the seed
  123.            of a RanDOOM .LMP.
  124.  
  125.   w     :  Create/edit RanDOOM .W file as lmpfile.w from a template. It looks
  126.            for and saves these files in the LMP\RANDOOM directory.
  127.  
  128.   t     :  Create/edit introductory text file as lmpfile.txt. ALFRED will 
  129.            check the seven directories for a corresponding lmpfile.lmp, and
  130.            if it does not find any, ALFRED will ask where to put it.
  131.  
  132.   p     :  Plays DOOM according to a RanDOOM .W file lmpfile.w and a 
  133.            random seed (no .LMPs played or recorded).
  134.  
  135. pwadfile:  If ALFRED discovers a second parameter (or third parameter when
  136.            recording) as pwadfile, it will first check to see if pwadfile.wad 
  137.            exists in the WADS directory. If it could not find pwadfile.wad,
  138.            then ALFRED will ask if it was intended to be a RanDOOM seed.
  139.  
  140.   seed  :  If playing or recording a RanDOOM .LMP, then a seed must be
  141.            provided as the 3rd parameter.
  142.  
  143.  
  144. ============
  145. [5] EXAMPLES
  146. ============
  147.  
  148. The best way to explain how to use ALFRED is by examples. Listed below is
  149. just about all the possible ways of using ALFRED:
  150.  
  151. lmp                     Typing 'lmp' without parameters will get a
  152.                         help screen.
  153.  
  154. lmp list                Displays a list of all .LMPs in any of the seven
  155.                         directories (HALL, LEVELS, MISC, MULTIPLR, NITEMARE,
  156.                         PWAD, RANDOOM)
  157.  
  158. lmp lmpfile             Searches for lmpfile.lmp in the seven directories
  159.                         and plays it. NOTE: For RanDOOM lmps, you must
  160.                         provide a seed as a second parameter.
  161.  
  162. lmp lmpfile pwadfile    Plays lmpfile.lmp with pwadfile.wad. If lmpfile and
  163.                         pwadfile have the same name, then no second parameter
  164.                         need be given.
  165.                         
  166. lmp lmpfile c           Plays lmpfile.lmp from the LMP\RANDOOM directory with
  167.                         seed 'c'. NOTE: you must also have lmpfile.w and 
  168.                         lmpfile.txt in the LMP\RANDOOM directory in order to 
  169.                         view it.
  170.  
  171. lmp r lmpfile           Records a DOOM session under lmpfile.lmp, and
  172.                         will prompt for directory, episode, level and
  173.                         skill.
  174.  
  175. lmp r lmpfile pwadfile  Records lmpfile.lmp using pwadfile.wad as a PWAD
  176.                         file. Since it is a PWAD .LMP, it will be placed in
  177.                         the LMP\PWAD directory automatically.
  178.  
  179. lmp r lmpfile c         Records a DOOM session under lmpfile.lmp as
  180.                         a RanDOOM .LMP, with seed 'c'. Will prompt for 
  181.                         episode, level and skill. NOTE: you must have 
  182.                         created a lmpfile.w weight file beforehand in the 
  183.                         \LMP\RANDOOM directory. 
  184.  
  185. lmp w wfile             Creates a new RanDOOM .w file, using a basic template, 
  186.                         or edits an already existing .w file (automatically 
  187.                         located in the LMP\RANDOOM directory). This option 
  188.                         uses the MS-DOS editor.
  189.  
  190. lmp t txtfile           Creates a new .LMP intro text file, using a basic
  191.                         template, or edits an already existing one. The user 
  192.                         will be asked which of the seven directories for it 
  193.                         to be put in. This option uses the MS-DOS editor.
  194.  
  195. lmp p wfile c           Plays DOOM with the RanDOOM weight file wfile.w, with
  196.                         seed 'c'. The seed is optional, although it really 
  197.                         should always be included.
  198.  
  199. ===========================================
  200. [6] PWAD LMPS: RECORDING THE FUTURE OF DOOM
  201. ===========================================
  202.  
  203. At the last moment I decided to make a small addition to implement the
  204. recording and playing of PWAD .LMPs. Unfortunately, at this point the
  205. ALFRED batch file was beginning to look a bit like the ALFRED PATCH file, so
  206. deciding how to implement it wasn't easy. 
  207.  
  208. To begin with, I decided that I would not restrict the user's freedom by 
  209. making him put all his wads in a special directory. Rather, at the beginning
  210. of LMP.BAT I put the command
  211.  
  212. SET WADPATH=LMP\PWAD
  213.  
  214. Here you may put the directory path where your pwad files are stored. If you 
  215. had C:\DOOM\WADS as your wadfile directory, then you would put 
  216. SET WADPATH=WADS
  217.  
  218. Right now it is set to look in the LMP\PWAD directory since there are 
  219. some dandy .LMPs there ready for viewing which need their respective pwads. 
  220. Take note that throughout this document I will refer to this user-specified 
  221. pwad directory as the WADS directory.
  222.  
  223. To play a PWAD .LMP file you must have the following:
  224.  
  225. 1) Knowledge of what pwad file was used to record your .LMP,
  226. 2) Have your pwad file in the WADS directory,
  227. 3) Have you .LMP in the LMP\PWAD directory.
  228.  
  229. Once these are set you may view it by typing:
  230.  
  231.      LMP lmpfile pwadfile
  232.  
  233. If your pwadfile has the same name as your lmpfile, then it isn't necessary
  234. to include the second parameter.
  235.  
  236. Recording is similar:
  237.  
  238.      LMP r lmpfile pwadfile
  239.  
  240. Unlike playing however, you MUST specify the pwad file to use, EVEN if
  241. it has the same name.
  242.  
  243. Before the pwad option was made, ALFRED used the third parameter as a seed for
  244. RanDOOM. This hasn't changed, except that now ALFRED will first look to see if
  245. the third parameter is intended to be a pwad file. If it cannot find the pwad 
  246. file in the WADS directory, ALFRED will then ask if the third parameter was 
  247. intended to be a RanDOOM seed.
  248.  
  249. PLEASE NOTE: I have recently noticed that some pwad .wad files do not record 
  250. correctly. My guess is that the editor that was used to change the pwad file 
  251. did not save it correctly. It seems the problem is when I use VERDA, but not 
  252. DEU 4.31. Here's how I came to this conclusion:
  253.  
  254. I edited E2L4 with VERDA, and changed only one item at the beginning into a
  255. chainsaw. When recording, everything worked normally. However, when replaying
  256. the level, it seems that the monsters were all blind, and didn't notice me 
  257. until I shot. I tried exactly the same thing with DEU 4.31 and the .LMP
  258. recorded and played correctly.
  259.  
  260. All pwad .LMPs included with this package have been tested and
  261. work correctly. 
  262.  
  263.  
  264. ======================================================
  265. [7] RANDOOM LMPS: A NEW BEGINNING IN VISUAL EXCITEMENT
  266. ======================================================
  267.  
  268. (NOTE: Please refer to the RanDOOM manual for familiarity of the program.
  269.        The following section assumes you've used RanDOOM before).
  270.  
  271. ALFRED has the ability to play and record .LMP files that are made with
  272. RanDOOM. These .LMPs have been surprisingly the most exciting .LMPs seen yet!
  273.  
  274. Because RanDOOM has the ability to randomize by a seed, it is possible to
  275. 'save' a randomized .WAD file for future use. All that is needed is both the 
  276. seed and the .W weight file.
  277.  
  278. With this in mind, it is possible to create an .LMP file with a RanDOOM 
  279. configuration, although it would be tedious to re-create the exact same 
  280. environment every time you wished to view the .LMP. Fortunately, ALFRED 
  281. helps out tremendously by automatically executing the proper parameters 
  282. required to view the .LMP and then reseting the .WAD file back to normal 
  283. once the film has been viewed.
  284.  
  285. To view an .LMP file, you will need the to have the following 3 files
  286. inside the LMP\RANDOOM\ directory:
  287.  
  288.         1) The actual .LMP file to be viewed.
  289.         2) The .W weight file.
  290.         3) An .LMP introductory .TXT file showing which 
  291.            seed to use.
  292.  
  293. ALFRED will know if there are any problems, and will tell you how to go 
  294. about fixing them. It also has an option to edit either the .W or .TXT 
  295. file, and will ALWAYS automatically put everything in the LMP\RANDOOM 
  296. directory.
  297.  
  298. ALFRED will record RanDOOM with the -M3 parameter, as opposed to the old 
  299. -M2 parameter. When recording a RanDOOM .LMP, ALFRED will ask you whether
  300. you want RanDOOM to (1) change ALL the levels of the game, or (2) change
  301. only the level being recorded. It's much more convenient to choose just one 
  302. level, since it takes MUCH less time to process when you view the .LMP. Make 
  303. sure you keep note of what level it is, however, since ALFRED will ask you 
  304. for it when you want to see the .LMP. 
  305.  
  306. NOTE: Options (1) and (2) will give different randoom setups for the same 
  307.       level, EVEN if the same seed is used.
  308.  
  309. If you create or edit the weight file with the 'LMP w lmpfile' command, the 
  310. batch file will load up the MS-DOS editor with a template of a standard .w 
  311. file which has been saved with under the filename you specified. This makes 
  312. it easy to change or modify small parameters without having to start from
  313. scratch or copy or move files around. This also applies to the 'LMP t'
  314. command for .LMP introductory text files. If you don't like the MS-DOS 
  315. editor and want to use another one, just change the batch file accordingly.
  316.  
  317.  
  318. ===============
  319. [8] FINAL WORDS
  320. ===============
  321.  
  322. If all this still sounds kinda tricky or tedious to you, don't worry. After 
  323. the first few tries you'll be recording RanDOOM .LMPs in a flash. No kidding, 
  324. I tried it on my younger brother, and even he managed to figure it out.
  325.  
  326. Since ALFRED could be classifed as being a Third Party Doom Utility, I guess 
  327. I should mention that id Software had nothing to do with the creation of 
  328. ALFRED, so please don't bug them about any related queries. 
  329.  
  330. And since it's a batch file which you could edit yourself, don't bug me 
  331. either. Actually, I'm only kidding. If you have any problems or suggestions, 
  332. don't hesitate to contact me.
  333.  
  334. I would also like to say that neither me nor ALFRED are to be held 
  335. responsible for any sort of data loss. You could still flame me if it does
  336. happen though, just so I can fix it in the next version.
  337.  
  338. Thanks to all you who helped me out during the development of ALFRED, 
  339. especially Scott Coleman for letting me use RanDOOM with ALFRED, and John
  340. Van Essen, who provided both fresh ideas and criticisms toward ALFRED. 
  341.  
  342. Finally, a VERY BIG THANK YOU to the folks at id Software for making DOOM 
  343. not only the most playable action game out for the PC, but also the most
  344. re-playble.
  345.  
  346. I hope ALFRED helps you out a bit, and I am looking forward to seeing your
  347. new ALFRED influenced .LMPs.
  348.  
  349. - Michael Houston
  350.   mp_hous@pavo.concordia.ca
  351.